System Reference Guide
The following sections describe the resources available when programming your system, and what they do. Each section represents a menu selection within the user interface, and the relevant options available.
Programming Window
The programming window is where you program items in the system. When you select a resource menu from the side menu, or navigate to a menu from another page or link, the programming window displays all records currently programmed under that resource menu. For example, clicking on the Users menu will display the list of all users.
The following programming functions are common to most menus.
-
Add: Initiates the process for creating a new record under the selected menu.
The operator must have a role assigned which allows 'create rights' for the selected resource.
-
Edit: Provides access to configuration of existing records.
The operator must have a role assigned which allows 'update rights' for the selected resource.
-
Delete: Deletes the selected record(s).
- When viewing a list, records can be selected by ticking the selection checkbox (see below). Select one or more records, then click Delete. Click Yes to confirm the deletion.
The operator must have a role assigned which allows 'delete rights' for the selected resource.
-
Refresh: Reloads the menu page.
This will typically not be required unless experiencing internet disruptions as Protege X updates live, even with changes from other operators.
-
Bulk Edit: The bulk edit feature is still being developed and should not be used in live environments. Bulk editing may cause unexpected results.
- Filter by name: A fast and convenient way to find records by the record name. Click in the field and enter at least one alphanumeric character. Protege X will begin to search for any record containing your entry in its description. If there are too many results you may want to refine your search with a more detailed description.
- Sort by name: Record lists are displayed alphabetically and can be sorted in ascending or descending order by clicking the Name column header or the arrow (h or i) icon.
- Selection checkbox: Used to select one or more records to either delete or bulk edit.
When you click on a record the programming details for that record will open in the programming window. To return to the resource menu click X to close the record details.
For resources which support manual commands (doors, areas, inputs, outputs, controllers, expander modules, elevator floors and services), this functionality can be accessed from the main page of the relevant resource type. Clicking the button beside a record (only visible when hovering) opens a menu with manual commands for that resource type.
Manual commands can only be performed by operators whose assigned role has the Create Right enabled for the specific resource type.
All records have at least two name fields, which are used to accommodate displaying records in different languages and on compatible devices.
- Name: This is the name which appears throughout the English version of the Protege X system, and in event logs.
-
Name (Second Language): The name which appears when the user interface is set to a language other than English.
-
Keypad Display Name: The name that will be downloaded to the controller. This will be displayed on the keypad and in reports by IP monitoring services.
This name should be recognizable to end users. For example, if the end user is arming an area and there are some inputs open they should be able to easily identify which inputs they need to check on before leaving the premises.
The keypad can only display the first 16 characters of the display name, so it should concisely describe the physical location and function of the resource.
In Protege X the database ID is displayed in the URL when you navigate to each record.
When you view a child record the URL includes the database IDs of the parent records.
This is how you identify the IDs that you will use when programming commands and other functions that require database IDs.
For many resource types, when you select a specific record you will see a Related objects menu on the right side of the screen. This view is designed to provide a convenient relational map of the usage of each resource.
For example, when you select a schedule you can easily identify which access levels, doors, areas and other related records the schedule applies to. For doors you can see which reader expander ports, door groups and access levels the door record is assigned to. For a menu group, which keypads and access levels it is used in, and so on.
For hostable resource types the record's host controller is also displayed in the related objects list. For more information, see the Protege X Record Hierarchy.
Common Programming Functions